• Create ticket/issue

Follow the guide to enable codebase context checks.

Objective: Ensure all identifiers clearly express their purpose and intent, making code
self-documenting

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To prevent the leakage of sensitive system information through error messages while
providing sufficient detail for internal debugging.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To ensure logs are useful for debugging and auditing without exposing sensitive
information like PII, PHI, or cardholder data.

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: Ensure all data inputs are validated, sanitized, and handled securely to prevent
vulnerabilities

Status: Passed

Learn more about managing compliance generic rules or creating your own custom rules

Objective: To create a detailed and reliable record of critical system actions for security analysis
and compliance.

Status:
Audit Logging: The new cache computation and stats retrieval logic performs critical actions (e.g.,
computing and distributing shared RAM usage) without evident audit logging of access or
changes, but visibility into the broader logging framework is limited in this diff.

public static Map<ShardId, Long> getSharedRamSizeForAllShards(IndicesService indicesService) {
    Map<ShardId, Long> shardIdToSharedRam = new HashMap<>();
    IndicesQueryCache.CacheTotals cacheTotals = IndicesQueryCache.getCacheTotalsForAllShards(indicesService);
    for (IndexService indexService : indicesService) {
        for (IndexShard indexShard : indexService) {
            final var queryCache = indicesService.getIndicesQueryCache();
            long sharedRam = (queryCache == null) ? 0L : queryCache.getSharedRamSizeForShard(indexShard.shardId(), cacheTotals);
            // as a size optimization, only store non-zero values in the map
            if (sharedRam > 0L) {
                shardIdToSharedRam.put(indexShard.shardId(), sharedRam);
            }
        }
    }
    return Collections.unmodifiableMap(shardIdToSharedRam);
}

public long getCacheSizeForShard(ShardId shardId) {
    Stats stats = shardStats.get(shardId);
    return stats != null ? stats.cacheSize : 0L;
}



 ... (clipped 4 lines)

Learn more about managing compliance generic rules or creating your own custom rules

Objective: Ensure comprehensive error handling that provides meaningful context and graceful
degradation

Status:
Edge Cases: The new Supplier-based shared RAM computation may return null or zero values for shards,
and while defaults are used in places, comprehensive handling of failures from supplier
evaluation (e.g., exceptions or empty maps) is not evident from the diff.

@Override
protected void shardOperation(
    IndicesStatsRequest request,
    ShardRouting shardRouting,
    Task task,
    Supplier<IndicesQueryCache.CacheTotals> context,
    ActionListener<ShardStats> listener
) {
    ActionListener.completeWith(listener, () -> {
        assert task instanceof CancellableTask;
        IndexService indexService = indicesService.indexServiceSafe(shardRouting.shardId().getIndex());
        IndexShard indexShard = indexService.getShard(shardRouting.shardId().id());
        CommonStats commonStats = CommonStats.getShardLevelStats(
            indicesService.getIndicesQueryCache(),
            indexShard,
            request.flags(),
            () -> {
                final IndicesQueryCache queryCache = indicesService.getIndicesQueryCache();
                IndicesQueryCache.CacheTotals freshTotals = IndicesQueryCache.getCacheTotalsForAllShards(indicesService);
                return (queryCache == null) ? 0L : queryCache.getSharedRamSizeForShard(indexShard.shardId(), freshTotals);
            }


 ... (clipped 2 lines)

Learn more about managing compliance generic rules or creating your own custom rules

Fix a division-by-zero error in the shared RAM calculation. When
totalItemsInCache is zero, the code should divide by shardCount instead to
correctly apportion memory usage.

server/src/main/java/org/elasticsearch/indices/IndicesQueryCache.java [177-180]

 if (totalItemsInCache == 0) {
     // all shards have zero cache footprint, so we apportion the size of the shared bytes equally across all shards
-    additionalRamBytesUsed = Math.round((double) sharedRamBytesUsed / totalItemsInCache);
+    additionalRamBytesUsed = Math.round((double) sharedRamBytesUsed / shardCount);
 } else {

• Apply / Chat

Improve performance by using the cached context in shardOperation. The current
implementation re-calculates CacheTotals for each shard, negating the
performance benefit of the newly introduced caching mechanism.

server/src/main/java/org/elasticsearch/action/admin/indices/stats/TransportIndicesStatsAction.java [135-144]

 CommonStats commonStats = CommonStats.getShardLevelStats(
     indicesService.getIndicesQueryCache(),
     indexShard,
     request.flags(),
     () -> {
         final IndicesQueryCache queryCache = indicesService.getIndicesQueryCache();
-        IndicesQueryCache.CacheTotals freshTotals = IndicesQueryCache.getCacheTotalsForAllShards(indicesService);
-        return (queryCache == null) ? 0L : queryCache.getSharedRamSizeForShard(indexShard.shardId(), freshTotals);
+        IndicesQueryCache.CacheTotals totals = context.get();
+        return (queryCache == null) ? 0L : queryCache.getSharedRamSizeForShard(indexShard.shardId(), totals);
     }
 );

• Apply / Chat